Skip to content

docs: fix two broken tutorial notebook links in README - #524

Open
vaibhav8a wants to merge 1 commit into
DeepTrackAI:developfrom
vaibhav8a:fix-readme-tutorial-links
Open

docs: fix two broken tutorial notebook links in README#524
vaibhav8a wants to merge 1 commit into
DeepTrackAI:developfrom
vaibhav8a:fix-readme-tutorial-links

Conversation

@vaibhav8a

Copy link
Copy Markdown

Two tutorial links in the README point at notebook filenames that don't exist on develop, so both the GitHub link and the "Open in Colab" badge 404.

README entry Linked path Actual path on develop
DTGS172 — Simulating Bacteria tutorials/1-getting-started/DTGS172_custom_scatterers_bacteria.ipynb tutorials/1-getting-started/DTGS172_bacteria.ipynb
DTAT355 — deeptrack.types tutorials/3-advanced-topics/DTAT_387_types.ipynb tutorials/3-advanced-topics/DTAT355_types.ipynb

Both corrections are unambiguous: the DTGS172_ and DTAT355 prefixes in the README's own entry labels match exactly one notebook each in the tree, and no notebook by either linked name exists on any branch.

Each line carries the path twice (the markdown link and the Colab badge href), so four occurrences were updated in total. README-only change.

DTGS172 pointed at DTGS172_custom_scatterers_bacteria.ipynb and DTAT355
pointed at DTAT_387_types.ipynb; neither file exists. The actual notebooks
are DTGS172_bacteria.ipynb and DTAT355_types.ipynb. Both the GitHub link
and the Colab badge href were 404ing on each entry.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant